<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">

<html><head><title>Helper functions - jstree</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>

<!--  Generated by Natural Docs, version 1.5 -->
<!--  http://www.naturaldocs.org  -->

<!-- saved from url=(0026)http://www.naturaldocs.org -->




<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="Helper_functions"></a>Helper functions</h1><div class=CBody><p>This file includes some functions that enable CSS manipulations, contextmenus, XSLT transformations and drag&rsquo;n&rsquo;drop.&nbsp; All of those work independently of jstree.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#Helper_functions" >Helper functions</a></td><td class=SDescription>This file includes some functions that enable CSS manipulations, contextmenus, XSLT transformations and drag&rsquo;n&rsquo;drop. </td></tr><tr class="SVariable SMarked"><td class=SEntry><a href="#$.vakata" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">$.vakata</a></td><td class=SDescription><b>object</b> Holds all helper objects.</td></tr><tr class="SFunction"><td class=SEntry><a href="#$().vakata_reverse" >$().vakata_reverse</a></td><td class=SDescription>Makes it possible to apply the standard array reverse function to a jQuery collection.</td></tr><tr class="SFunction SMarked"><td class=SEntry><a href="#$.vakata.array_remove" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">$.vakata.<wbr>array_remove</a></td><td class=SDescription>Makes it possible to remove an item (or a group of items) form an array. </td></tr><tr class="SGroup"><td class=SEntry><a href="#CSS" >CSS</a></td><td class=SDescription>Functions needed to manipulate stylesheets (add, remove, change)</td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.css" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">$.vakata.css</a></td><td class=SDescription><b>object</b> holds all CSS related functions</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#$.vakata.css.get_css" >$.vakata.<wbr>css.<wbr>get_css</a></td><td class=SDescription>Retrieves or deletes a specific rule.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.css.add_css" >$.vakata.<wbr>css.<wbr>add_css</a></td><td class=SDescription>Adds a rule.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#$.vakata.css.remove_css" >$.vakata.<wbr>css.<wbr>remove_css</a></td><td class=SDescription>Removes a rule, this functions is a shortcut to <a href="#$.vakata.css.get_css" class=LFunction id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">$.vakata.css.get_css</a> with the delete flag set to true.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.css.add_sheet" >$.vakata.<wbr>css.<wbr>add_sheet</a></td><td class=SDescription>Adds a whole stylesheet or appends to an existing stylesheet.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Drag'n'drop" >Drag&rsquo;n&rsquo;drop</a></td><td class=SDescription>Functions needed to drag&rsquo;n&rsquo;drop elements</td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.dnd" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">$.vakata.dnd</a></td><td class=SDescription><b>object</b> holds all DND related functions</td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#$.vakata.dnd.settings" >$.vakata.<wbr>dnd.<wbr>settings</a></td><td class=SDescription><b>object</b> holds the global settings object for DND. </td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.dnd.settings.scroll_speed" >$.vakata.<wbr>dnd.<wbr>settings.<wbr>scroll_speed</a></td><td class=SDescription><b>integer</b> how fast (pixel count for each step) should a scrollable parent scroll when dragging near the edge. </td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#$.vakata.dnd.settings.scroll_proximity" >$.vakata.<wbr>dnd.<wbr>settings.<wbr>scroll_proximity</a></td><td class=SDescription><b>integer</b> number of pixels from the edge of a scrollable parent below which the parent will start scrolling. </td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.dnd.settings.helper_left" >$.vakata.<wbr>dnd.<wbr>settings.<wbr>helper_left</a></td><td class=SDescription><b>integer</b> number of pixels left of the cursor to move the drag-helper to. </td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#$.vakata.dnd.settings.helper_top" >$.vakata.<wbr>dnd.<wbr>settings.<wbr>helper_top</a></td><td class=SDescription><b>integer</b> number of pixels below the cursor to move the drag-helper to. </td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.dnd.settings.threshold" >$.vakata.<wbr>dnd.<wbr>settings.<wbr>threshold</a></td><td class=SDescription><b>integer</b> amount of pixels required to move before the drag is started. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#$.vakata.dnd._trigger" >$.vakata.<wbr>dnd.<wbr>_trigger</a></td><td class=SDescription>Used internally to trigger all necessary events.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.dnd._clean" >$.vakata.<wbr>dnd.<wbr>_clean</a></td><td class=SDescription>Used internally to cleanup after a drop, so that all variables are nulled and ready for the next drag.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#$.vakata.dnd._scroll" >$.vakata.<wbr>dnd.<wbr>_scroll</a></td><td class=SDescription>Used internally to scroll hovered elements.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.dnd.start" >$.vakata.<wbr>dnd.<wbr>start</a></td><td class=SDescription>Use this function to start a drag (usually with the mousedown event)</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#$.vakata.dnd.drag" >$.vakata.<wbr>dnd.drag</a></td><td class=SDescription>Used internally to process the mousemove event after <a href="#$.vakata.dnd.start" class=LFunction id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">$.vakata.dnd.start</a> is called.</td></tr><tr class="SEvent SIndent1 SMarked"><td class=SEntry><a href="#dnd_start" >dnd_start</a></td><td class=SDescription>Marks the start of the drag. </td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#dnd_move" >dnd_move</a></td><td class=SDescription>Triggered multiple times while dragging. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.dnd.stop" >$.vakata.<wbr>dnd.stop</a></td><td class=SDescription>Used internally to process the mouseup event (drop) after <a href="#$.vakata.dnd.start" class=LFunction id=link7 onMouseOver="ShowTip(event, 'tt6', 'link7')" onMouseOut="HideTip('tt6')">$.vakata.dnd.start</a> is called.</td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#dnd_stop" >dnd_stop</a></td><td class=SDescription>Marks the end of the drag. </td></tr><tr class="SGroup"><td class=SEntry><a href="#XSLT" >XSLT</a></td><td class=SDescription>A function used to do XSLT transformations.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.xslt" id=link8 onMouseOver="ShowTip(event, 'tt7', 'link8')" onMouseOut="HideTip('tt7')">$.vakata.xslt</a></td><td class=SDescription>This functions transforms a XML string using a XSL string. </td></tr><tr class="SGroup"><td class=SEntry><a href="#Context_menu" >Context menu</a></td><td class=SDescription>Functions needed to show a custom context menu.</td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.context" id=link9 onMouseOver="ShowTip(event, 'tt8', 'link9')" onMouseOut="HideTip('tt8')">$.vakata.<wbr>context</a></td><td class=SDescription><b>object</b> holds all context menu related functions and variables.</td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#$.vakata.context.settings" >$.vakata.<wbr>context.<wbr>settings</a></td><td class=SDescription><b>object</b> holds the global settings object for context menus. </td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.context.settings.hide_onmouseleave" >$.vakata.<wbr>context.<wbr>settings.<wbr>hide_onmouseleave</a></td><td class=SDescription><b>integer</b> the amount of milliseconds to wait before hiding the menu after mouseleave. </td></tr><tr class="SVariable SIndent1"><td class=SEntry><a href="#$.vakata.context.settings.icons" >$.vakata.<wbr>context.<wbr>settings.<wbr>icons</a></td><td class=SDescription><b>boolean</b> whether to show icons or not. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.context._trigger" >$.vakata.<wbr>context.<wbr>_trigger</a></td><td class=SDescription>Used internally to trigger all necessary events.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#$.vakata.context._execute" >$.vakata.<wbr>context.<wbr>_execute</a></td><td class=SDescription>Used internally to execute the action (if any) associated with an item.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.context._parse" >$.vakata.<wbr>context.<wbr>_parse</a></td><td class=SDescription>Used internally to parse a contextmenu description object to an HTML string.</td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#context_parse" >context_parse</a></td><td class=SDescription>Triggered when the context menu is parsed but not yet shown. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.context._show_submenu" >$.vakata.<wbr>context.<wbr>_show_submenu</a></td><td class=SDescription>Used internally to show a submenu</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#$.vakata.context.show" >$.vakata.<wbr>context.show</a></td><td class=SDescription>Shows the context menu. </td></tr><tr class="SVariable SIndent1 SMarked"><td class=SEntry><a href="#context_menu_item" >context_menu_item</a></td><td class=SDescription><b>object</b> Used to construct a context menu entry, this structure will always be a part of an object.</td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#context_show" >context_show</a></td><td class=SDescription>Triggered when the context menu is shown. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#$.vakata.context.hide" >$.vakata.<wbr>context.hide</a></td><td class=SDescription>Used internally to hide the contextmenu after a click, or on mouseleave, etc.</td></tr><tr class="SEvent SIndent1"><td class=SEntry><a href="#context_hide" >context_hide</a></td><td class=SDescription>Triggered when the context menu is hidden. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata"></a>$.vakata</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.vakata</td></tr></table></blockquote><p><b>object</b> Holds all helper objects.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$().vakata_reverse"></a>$().vakata_reverse</h3><div class=CBody><p>Makes it possible to apply the standard array reverse function to a jQuery collection.</p><h4 class=CHeading>Input</h4><blockquote><pre class="prettyprint">&lt;div&gt;1&lt;/div&gt;&lt;div&gt;2&lt;/div&gt;&lt;div&gt;3&lt;/div&gt;
$(&quot;div&quot;).vakata_reverse().each(function () { document.write(this.innerHTML); });</pre></blockquote><h4 class=CHeading>Output</h4><blockquote><pre class="prettyprint">321</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.array_remove"></a>$.vakata.<wbr>array_remove</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>$.vakata.array_remove = function(</td><td class=PParameter nowrap>array,</td></tr><tr><td></td><td class=PParameter nowrap>from,</td></tr><tr><td></td><td class=PParameter nowrap>to</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Makes it possible to remove an item (or a group of items) form an array.&nbsp; <a href="http://ejohn.org/blog/javascript-array-remove/" class=LURL target=_top>http://ejohn.org/blog/javascript-array-remove/</a></p><h4 class=CHeading>Input</h4><blockquote><pre class="prettyprint">$.vakata.array_remove(['a', 'b', 'c'], 1);</pre></blockquote><h4 class=CHeading>Output</h4><blockquote><pre class="prettyprint">['a', 'c']</pre></blockquote></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="CSS"></a>CSS</h3><div class=CBody><p>Functions needed to manipulate stylesheets (add, remove, change)</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.css"></a>$.vakata.css</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.vakata.css</td></tr></table></blockquote><p><b>object</b> holds all CSS related functions</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.css.get_css"></a>$.vakata.<wbr>css.<wbr>get_css</h3><div class=CBody><p>Retrieves or deletes a specific rule.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>rule_name</td><td class=CDLDescription><b>string</b> the rule to search for (any CSS rule)</td></tr><tr><td class=CDLEntry>delete_flag</td><td class=CDLDescription><b>boolean</b> whether you want to delete or simply retrieve a reference to the rule</td></tr><tr><td class=CDLEntry>sheet</td><td class=CDLDescription>the sheet to search in (do not specify this to search in all sheets)</td></tr></table><h4 class=CHeading>Returns either</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>a reference to the rule</td><td class=CDLDescription>if it was found and the delete flag was not set</td></tr><tr><td class=CDLEntry>true</td><td class=CDLDescription>if the delete flag was set and the rule was successfully removed</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription>if the rule could not be found</td></tr></table><h4 class=CHeading>See also</h4><p><a href="#$.vakata.css.remove_css" class=LFunction id=link10 onMouseOver="ShowTip(event, 'tt9', 'link10')" onMouseOut="HideTip('tt9')">$.vakata.css.remove_css</a></p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.css.add_css"></a>$.vakata.<wbr>css.<wbr>add_css</h3><div class=CBody><p>Adds a rule.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>rule_name</td><td class=CDLDescription><b>string</b> the rule to add</td></tr><tr><td class=CDLEntry>sheet</td><td class=CDLDescription>a reference to the sheet to add to</td></tr></table><h4 class=CHeading>Returns either</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>a reference to the rule</td><td class=CDLDescription>if the rule was added</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription>if the rule could not be added, or if such a rule already exists</td></tr></table></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.css.remove_css"></a>$.vakata.<wbr>css.<wbr>remove_css</h3><div class=CBody><p>Removes a rule, this functions is a shortcut to <a href="#$.vakata.css.get_css" class=LFunction id=link11 onMouseOver="ShowTip(event, 'tt4', 'link11')" onMouseOut="HideTip('tt4')">$.vakata.css.get_css</a> with the delete flag set to true.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>rule_name</td><td class=CDLDescription><b>string</b> the rule to remove</td></tr><tr><td class=CDLEntry>sheet</td><td class=CDLDescription>the sheet to remove from (you can omit this and all sheets will be searched)</td></tr></table><h4 class=CHeading>Returns either</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>true</td><td class=CDLDescription>if rule was removed</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription>if the rule could not be removed</td></tr></table><h4 class=CHeading>See also</h4><p><a href="#$.vakata.css.get_css" class=LFunction id=link12 onMouseOver="ShowTip(event, 'tt4', 'link12')" onMouseOut="HideTip('tt4')">$.vakata.css.get_css</a></p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.css.add_sheet"></a>$.vakata.<wbr>css.<wbr>add_sheet</h3><div class=CBody><p>Adds a whole stylesheet or appends to an existing stylesheet.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription><b>object</b>:</td></tr><tr><td class=CDLEntry>options.url</td><td class=CDLDescription>location of the stylesheet - when this is supplied <u>options.str</u> and <u>options.title</u> should not be set and a new LINK element is always created</td></tr><tr><td class=CDLEntry>options.str</td><td class=CDLDescription>text content of the stylesheet - when this is supplied <u>options.url</u> is not used.&nbsp; A STYLE element is used.</td></tr><tr><td class=CDLEntry>options.title</td><td class=CDLDescription>the ID of the added stylesheet (if you pass `foo` the ID will be `foo-stylesheet`), when the stylesheet exists the content is appended and no new stylesheet is created.</td></tr></table><h4 class=CHeading>Returns</h4><p>a reference to the stylesheet</p></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Drag'n'drop"></a>Drag&rsquo;n&rsquo;drop</h3><div class=CBody><p>Functions needed to drag&rsquo;n&rsquo;drop elements</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd"></a>$.vakata.dnd</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.vakata.dnd</td></tr></table></blockquote><p><b>object</b> holds all DND related functions</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd.settings"></a>$.vakata.<wbr>dnd.<wbr>settings</h3><div class=CBody><p><b>object</b> holds the global settings object for DND.&nbsp; You can easily modify any of the settings.</p><blockquote><pre class="prettyprint">// modification example
$.vakata.dnd.settings.threshold = 10;</pre></blockquote></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd.settings.scroll_speed"></a>$.vakata.<wbr>dnd.<wbr>settings.<wbr>scroll_speed</h3><div class=CBody><p><b>integer</b> how fast (pixel count for each step) should a scrollable parent scroll when dragging near the edge.&nbsp; Default is <u>10</u>.</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd.settings.scroll_proximity"></a>$.vakata.<wbr>dnd.<wbr>settings.<wbr>scroll_proximity</h3><div class=CBody><p><b>integer</b> number of pixels from the edge of a scrollable parent below which the parent will start scrolling.&nbsp; Default is <u>20</u>.</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd.settings.helper_left"></a>$.vakata.<wbr>dnd.<wbr>settings.<wbr>helper_left</h3><div class=CBody><p><b>integer</b> number of pixels left of the cursor to move the drag-helper to.&nbsp; Default is <u>5</u>;</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd.settings.helper_top"></a>$.vakata.<wbr>dnd.<wbr>settings.<wbr>helper_top</h3><div class=CBody><p><b>integer</b> number of pixels below the cursor to move the drag-helper to.&nbsp; Default is <u>10</u>.</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd.settings.threshold"></a>$.vakata.<wbr>dnd.<wbr>settings.<wbr>threshold</h3><div class=CBody><p><b>integer</b> amount of pixels required to move before the drag is started.&nbsp; Default is <u>5</u>.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd._trigger"></a>$.vakata.<wbr>dnd.<wbr>_trigger</h3><div class=CBody><p>Used internally to trigger all necessary events.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd._clean"></a>$.vakata.<wbr>dnd.<wbr>_clean</h3><div class=CBody><p>Used internally to cleanup after a drop, so that all variables are nulled and ready for the next drag.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd._scroll"></a>$.vakata.<wbr>dnd.<wbr>_scroll</h3><div class=CBody><p>Used internally to scroll hovered elements.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd.start"></a>$.vakata.<wbr>dnd.<wbr>start</h3><div class=CBody><p>Use this function to start a drag (usually with the mousedown event)</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription><b>event</b> the event which started the drag, when used with the mousedown event text selection is prevented</td></tr><tr><td class=CDLEntry>data</td><td class=CDLDescription><b>mixed</b> some custom data you want to bind with that particular drag - you will receive this in all events</td></tr><tr><td class=CDLEntry>html</td><td class=CDLDescription><b>mixed</b> the text for the drag-helper as a <b>string</b>, if set to <u>false</u> no helper is shown</td></tr></table><h4 class=CHeading>Returns</h4><p>false</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$(&quot;span&quot;).bind(&quot;mousedown&quot;, function (e) {
   return $.vakata.dnd.start(e, {}, &quot;Dragging&quot;);
});</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd.drag"></a>$.vakata.<wbr>dnd.drag</h3><div class=CBody><p>Used internally to process the mousemove event after <a href="#$.vakata.dnd.start" class=LFunction id=link13 onMouseOver="ShowTip(event, 'tt6', 'link13')" onMouseOut="HideTip('tt6')">$.vakata.dnd.start</a> is called.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription><b>event</b> the mousemove event</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#dnd_start" class=LEvent id=link14 onMouseOver="ShowTip(event, 'tt10', 'link14')" onMouseOut="HideTip('tt10')">dnd_start</a>, <a href="#dnd_move" class=LEvent id=link15 onMouseOver="ShowTip(event, 'tt11', 'link15')" onMouseOut="HideTip('tt11')">dnd_move</a></p></div></div></div>

<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="dnd_start"></a>dnd_start</h3><div class=CBody><p>Marks the start of the drag.&nbsp; Triggered on the document after a drag is initiated using <a href="#$.vakata.dnd.start" class=LFunction id=link16 onMouseOver="ShowTip(event, 'tt6', 'link16')" onMouseOut="HideTip('tt6')">$.vakata.dnd.start</a> and the user has moved more than <a href="#$.vakata.dnd.settings.threshold" class=LVariable id=link17 onMouseOver="ShowTip(event, 'tt12', 'link17')" onMouseOut="HideTip('tt12')">$.vakata.dnd.settings.threshold</a> pixels, the event is fired in the <b>vakata</b> namespace.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.event</td><td class=CDLDescription>the mousemove event</td></tr><tr><td class=CDLEntry>data.data</td><td class=CDLDescription>the data you supplied when calling <a href="#$.vakata.dnd.start" class=LFunction id=link18 onMouseOver="ShowTip(event, 'tt6', 'link18')" onMouseOut="HideTip('tt6')">$.vakata.dnd.start</a></td></tr><tr><td class=CDLEntry>data.element</td><td class=CDLDescription>the origin element</td></tr><tr><td class=CDLEntry>data.helper</td><td class=CDLDescription>the jquery extended drag-helper node (or false if it is not used)</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$(document).bind(&quot;dnd_start.vakata&quot;, function (e, data) {
   // do something
});</pre></blockquote></div></div></div>

<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="dnd_move"></a>dnd_move</h3><div class=CBody><p>Triggered multiple times while dragging.&nbsp; This event is triggered on the document after the <a href="#dnd_start" class=LEvent id=link19 onMouseOver="ShowTip(event, 'tt10', 'link19')" onMouseOut="HideTip('tt10')">dnd_start</a> event when the user moves the mouse, the event is fired in the <b>vakata</b> namespace.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.event</td><td class=CDLDescription>the mousemove event</td></tr><tr><td class=CDLEntry>data.data</td><td class=CDLDescription>the data you supplied when calling <a href="#$.vakata.dnd.start" class=LFunction id=link20 onMouseOver="ShowTip(event, 'tt6', 'link20')" onMouseOut="HideTip('tt6')">$.vakata.dnd.start</a></td></tr><tr><td class=CDLEntry>data.element</td><td class=CDLDescription>the origin element</td></tr><tr><td class=CDLEntry>data.helper</td><td class=CDLDescription>the jquery extended drag-helper node (or false if it is not used)</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$(document).bind(&quot;dnd_move.vakata&quot;, function (e, data) {
   // do something
});</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.dnd.stop"></a>$.vakata.<wbr>dnd.stop</h3><div class=CBody><p>Used internally to process the mouseup event (drop) after <a href="#$.vakata.dnd.start" class=LFunction id=link21 onMouseOver="ShowTip(event, 'tt6', 'link21')" onMouseOut="HideTip('tt6')">$.vakata.dnd.start</a> is called.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription><b>event</b> the mouseup event</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#dnd_stop" class=LEvent id=link22 onMouseOver="ShowTip(event, 'tt13', 'link22')" onMouseOut="HideTip('tt13')">dnd_stop</a></p></div></div></div>

<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="dnd_stop"></a>dnd_stop</h3><div class=CBody><p>Marks the end of the drag.&nbsp; This event is triggered on the document after <a href="#dnd_start" class=LEvent id=link23 onMouseOver="ShowTip(event, 'tt10', 'link23')" onMouseOut="HideTip('tt10')">dnd_start</a> (and possibly <a href="#dnd_move" class=LEvent id=link24 onMouseOver="ShowTip(event, 'tt11', 'link24')" onMouseOut="HideTip('tt11')">dnd_move</a>) when a drop (mouseup) occurs or when the drag is programatically terminated, the event is fired in the <b>vakata</b> namespace.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>data.event</td><td class=CDLDescription>the mouseup event (or <u>null</u> if stopped programatically using &lt;$.vakata.dnd.stop&gt;())</td></tr><tr><td class=CDLEntry>data.data</td><td class=CDLDescription>the data you supplied when calling <a href="#$.vakata.dnd.start" class=LFunction id=link25 onMouseOver="ShowTip(event, 'tt6', 'link25')" onMouseOut="HideTip('tt6')">$.vakata.dnd.start</a></td></tr><tr><td class=CDLEntry>data.element</td><td class=CDLDescription>the origin element</td></tr><tr><td class=CDLEntry>data.helper</td><td class=CDLDescription>the jquery extended drag-helper node (or false if it is not used)</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$(document).bind(&quot;dnd_stop.vakata&quot;, function (e, data) {
   // do something
});</pre></blockquote></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="XSLT"></a>XSLT</h3><div class=CBody><p>A function used to do XSLT transformations.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.xslt"></a>$.vakata.xslt</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>$.vakata.xslt = function (</td><td class=PParameter nowrap>xml,</td></tr><tr><td></td><td class=PParameter nowrap>xsl,</td></tr><tr><td></td><td class=PParameter nowrap>callback</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>This functions transforms a XML string using a XSL string.&nbsp; The result is passed to a callback function.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>xml</td><td class=CDLDescription><b>string</b> the source xml string</td></tr><tr><td class=CDLEntry>xsl</td><td class=CDLDescription><b>string</b> the xsl string</td></tr><tr><td class=CDLEntry>callback</td><td class=CDLDescription><b>function</b> this function is called in the global scope and is passed the result document</td></tr></table><h4 class=CHeading>Returns</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>true</td><td class=CDLDescription>if the browser supports xslt tranfsormation with strings</td></tr><tr><td class=CDLEntry>false</td><td class=CDLDescription>if the browser does not support xslt transformations with strings</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">// simple
$.vakata.xslt(&quot;&lt;xml-string-here&gt;&quot;, &quot;&lt;xsl-string-here&gt;&quot;, function (res) { $(&quot;#some-container&quot;).append(res); });
// with scope
$.vakata.xslt(&quot;&lt;xml-string-here&gt;&quot;, &quot;&lt;xsl-string-here&gt;&quot;, $.proxy(function (res) {
   this.some_process(res);
}, some_object);</pre></blockquote></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Context_menu"></a>Context menu</h3><div class=CBody><p>Functions needed to show a custom context menu.</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.context"></a>$.vakata.<wbr>context</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.vakata.context</td></tr></table></blockquote><p><b>object</b> holds all context menu related functions and variables.</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.context.settings"></a>$.vakata.<wbr>context.<wbr>settings</h3><div class=CBody><p><b>object</b> holds the global settings object for context menus.&nbsp; You can easily modify any of the settings.</p><blockquote><pre class="prettyprint">// modification example
$.vakata.context.settings.icons = false;</pre></blockquote></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.context.settings.hide_onmouseleave"></a>$.vakata.<wbr>context.<wbr>settings.<wbr>hide_onmouseleave</h3><div class=CBody><p><b>integer</b> the amount of milliseconds to wait before hiding the menu after mouseleave.&nbsp; If set to <u>0</u> the menu won&rsquo;t hide on mouseleave.&nbsp; Default is <u>0</u>.</p></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="$.vakata.context.settings.icons"></a>$.vakata.<wbr>context.<wbr>settings.<wbr>icons</h3><div class=CBody><p><b>boolean</b> whether to show icons or not.&nbsp; Default is <u>true</u>.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.context._trigger"></a>$.vakata.<wbr>context.<wbr>_trigger</h3><div class=CBody><p>Used internally to trigger all necessary events.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.context._execute"></a>$.vakata.<wbr>context.<wbr>_execute</h3><div class=CBody><p>Used internally to execute the action (if any) associated with an item.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>i</td><td class=CDLDescription>the item&rsquo;s internal index</td></tr></table></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.context._parse"></a>$.vakata.<wbr>context.<wbr>_parse</h3><div class=CBody><p>Used internally to parse a contextmenu description object to an HTML string.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>o</td><td class=CDLDescription><b>object</b> the contextmenu description object</td></tr><tr><td class=CDLEntry>is_callback</td><td class=CDLDescription><b>boolean</b> used internally to indicate a recursive call</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#context_parse" class=LEvent id=link26 onMouseOver="ShowTip(event, 'tt14', 'link26')" onMouseOut="HideTip('tt14')">context_parse</a></p></div></div></div>

<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="context_parse"></a>context_parse</h3><div class=CBody><p>Triggered when the context menu is parsed but not yet shown.&nbsp; This event is triggered on the document in the <b>vakata</b> namespace.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>reference</td><td class=CDLDescription>the DOM node used when <a href="#$.vakata.context.show" class=LFunction id=link27 onMouseOver="ShowTip(event, 'tt15', 'link27')" onMouseOut="HideTip('tt15')">$.vakata.context.show</a> was called</td></tr><tr><td class=CDLEntry>element</td><td class=CDLDescription>the DOM node of the context menu (not yet populated and shown)</td></tr><tr><td class=CDLEntry>position</td><td class=CDLDescription>an object consisting of <u>x</u> and <u>y</u> keys, represinting the position of the menu (not yet shown)</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$(document).bind(&quot;context_parse.vakata&quot;, function (e, data) {
   // do something
});</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.context._show_submenu"></a>$.vakata.<wbr>context.<wbr>_show_submenu</h3><div class=CBody><p>Used internally to show a submenu</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.context.show"></a>$.vakata.<wbr>context.show</h3><div class=CBody><p>Shows the context menu.&nbsp; Please note that at least one of <u>reference</u> or <u>position</u> should be specified.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>reference</td><td class=CDLDescription><b>jquery</b> associate the menu with a DOM element (optional)</td></tr><tr><td class=CDLEntry>position</td><td class=CDLDescription><b>object</b> should contain <u>x</u> and <u>y</u> properties, those are the coordinates to show the menu at (optional</td></tr><tr><td class=CDLEntry>data</td><td class=CDLDescription><b>object</b> the contextmenu description object.&nbsp; It should consist of keys, each key should be a <a href="#context_menu_item" class=LVariable id=link28 onMouseOver="ShowTip(event, 'tt16', 'link28')" onMouseOut="HideTip('tt16')">context_menu_item</a>.</td></tr></table><h4 class=CHeading>Triggers</h4><p><a href="#context_show" class=LEvent id=link29 onMouseOver="ShowTip(event, 'tt17', 'link29')" onMouseOut="HideTip('tt17')">context_show</a></p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$(document).bind(&quot;contextmenu&quot;, function (e) {
   e.preventDefault();
   $.vakata.context.show(false, { x: e.pageX, y:e.pageY }, {
       &quot;create&quot; : {
           // only specify what you need
           &quot;separator_after&quot;   : true,
           &quot;label&quot;             : &quot;Create&quot;,
           &quot;action&quot;            : function (data) { alert(&quot;Create&quot;); }
       },
       &quot;rename&quot; : {
           &quot;label&quot;     : &quot;Rename&quot;,
           &quot;icon&quot;      : &quot;./some-icon.png&quot;,
           &quot;action&quot;    : function (data) { alert(&quot;Rename on &quot; + data.reference); }
       },
       &quot;edit&quot; : {
           &quot;label&quot; : &quot;Edit&quot;,
           // Clicking this won't hide the menu, the same can be achieved with:
           // &quot;action&quot; : function () { return false; }
           &quot;submenu&quot; : {
               &quot;copy&quot;  : { &quot;label&quot; : &quot;Copy&quot;, &quot;action&quot; : function () { } },
               &quot;cut&quot;   : { &quot;label&quot; : &quot;Cut&quot;, &quot;action&quot; : function () { } },
               &quot;paste&quot; : { &quot;label&quot; : &quot;Paste&quot;, &quot;_disabled&quot; : true, &quot;action&quot; : function () { } }
           }
       },
       &quot;delete&quot; : {
           &quot;separator_before&quot;  : true,
           &quot;label&quot;             : &quot;Delete&quot;,
           &quot;action&quot;            : function (data) { alert(&quot;Delete&quot;); }
       }
   });
});</pre></blockquote></div></div></div>

<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="context_menu_item"></a>context_menu_item</h3><div class=CBody><p><b>object</b> Used to construct a context menu entry, this structure will always be a part of an object.</p><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>separator_before</td><td class=CDLDescription><b>boolean</b> should there be a separator before the item.&nbsp; Default is <u>false</u>.</td></tr><tr><td class=CDLEntry>separator_after</td><td class=CDLDescription><b>boolean</b> should there be a separator after the item.&nbsp; Default is <u>false</u>.</td></tr><tr><td class=CDLEntry>icon</td><td class=CDLDescription><b>string</b> if supplied this string is used for an icon, if it contains <u>/</u> it is treated as file, otherwise it is applied as a class on an INS object.</td></tr><tr><td class=CDLEntry>label</td><td class=CDLDescription><b>string</b> the text for this item</td></tr><tr><td class=CDLEntry>submenu</td><td class=CDLDescription><b>object</b> if supplied this object is used to build a submenu.&nbsp; It should consist of keys, each of which is a <a href="#context_menu_item" class=LVariable id=link30 onMouseOver="ShowTip(event, 'tt16', 'link30')" onMouseOut="HideTip('tt16')">context_menu_item</a>.</td></tr><tr><td class=CDLEntry>_class</td><td class=CDLDescription><b>string</b> if supplied this class is applied to the LI node.</td></tr><tr><td class=CDLEntry>_disabled</td><td class=CDLDescription><b>boolean</b> is this item disabled.</td></tr><tr><td class=CDLEntry>action</td><td class=CDLDescription><b>functon</b> if supplied it will be executed when this item is clicked / activated.&nbsp; If not supplied or the function returns <u>false</u> the contextmenu won&rsquo;t be hidden after execution.&nbsp; To force a context use <u>$.proxy</u>.&nbsp; In the function you will receive a single argument which is an object, consisting of four keys: <u>item</u> (the <a href="#context_menu_item" class=LVariable id=link31 onMouseOver="ShowTip(event, 'tt16', 'link31')" onMouseOut="HideTip('tt16')">context_menu_item</a> object), <u>reference</u> (the DOM node used when <a href="#$.vakata.context.show" class=LFunction id=link32 onMouseOver="ShowTip(event, 'tt15', 'link32')" onMouseOut="HideTip('tt15')">$.vakata.context.show</a> was called), <u>element</u> (the DOM node of the context menu), <u>position</u> (an object consisting of <u>x</u> and <u>y</u> keys, represinting the current position of the menu)</td></tr></table><h4 class=CHeading>See also</h4><p><a href="#$.vakata.context.show" class=LFunction id=link33 onMouseOver="ShowTip(event, 'tt15', 'link33')" onMouseOut="HideTip('tt15')">$.vakata.context.show</a></p></div></div></div>

<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="context_show"></a>context_show</h3><div class=CBody><p>Triggered when the context menu is shown.&nbsp; This event is triggered on the document in the <b>vakata</b> namespace.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>reference</td><td class=CDLDescription>the DOM node used when <a href="#$.vakata.context.show" class=LFunction id=link34 onMouseOver="ShowTip(event, 'tt15', 'link34')" onMouseOut="HideTip('tt15')">$.vakata.context.show</a> was called</td></tr><tr><td class=CDLEntry>element</td><td class=CDLDescription>the DOM node of the context menu</td></tr><tr><td class=CDLEntry>position</td><td class=CDLDescription>an object consisting of <u>x</u> and <u>y</u> keys, represinting the position of the menu</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$(document).bind(&quot;context_show.vakata&quot;, function (e, data) {
   // do something
});</pre></blockquote></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="$.vakata.context.hide"></a>$.vakata.<wbr>context.hide</h3><div class=CBody><p>Used internally to hide the contextmenu after a click, or on mouseleave, etc.</p><h4 class=CHeading>Triggers</h4><p><a href="#context_hide" class=LEvent id=link35 onMouseOver="ShowTip(event, 'tt18', 'link35')" onMouseOut="HideTip('tt18')">context_hide</a></p></div></div></div>

<div class="CEvent"><div class=CTopic><h3 class=CTitle><a name="context_hide"></a>context_hide</h3><div class=CBody><p>Triggered when the context menu is hidden.&nbsp; This event is triggered on the document in the <b>vakata</b> namespace.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>reference</td><td class=CDLDescription>the DOM node used when <a href="#$.vakata.context.show" class=LFunction id=link36 onMouseOver="ShowTip(event, 'tt15', 'link36')" onMouseOut="HideTip('tt15')">$.vakata.context.show</a> was called</td></tr><tr><td class=CDLEntry>element</td><td class=CDLDescription>the DOM node of the context menu</td></tr><tr><td class=CDLEntry>position</td><td class=CDLDescription>an object consisting of <u>x</u> and <u>y</u> keys, represinting the position of the menu</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">$(document).bind(&quot;context_hide.vakata&quot;, function (e, data) {
   // do something
});</pre></blockquote></div></div></div>

</div><!--Content-->


<div id=Footer>Copyright &copy; 2010 Ivan Bozhanov&nbsp; &middot;&nbsp; Updated March 20th, 2011&nbsp; &middot;&nbsp; <a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->


<div id=Menu><div class=MTitle>jstree<div class=MSubTitle>jquery treeview plugin</div></div><div class=MEntry><div class=MFile><a href="_usage-txt.html">USAGE</a></div></div><div class=MEntry><div class=MFile><a href="_license-txt.html">LICENSE</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Core</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="jstree-core-js.html">jstree.<wbr>core.js</a></div></div><div class=MEntry><div class=MFile id=MSelected>Helper functions</div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Plugins</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="jstree-themes-js.html">jstree.<wbr>themes.js</a></div></div><div class=MEntry><div class=MFile><a href="jstree-ui-js.html">jstree.<wbr>ui.js</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="_lib/jquery-js.html">_lib\<wbr>jquery.js</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Index</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Events.html">Events</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div></div></div></div><script type="text/javascript"><!--
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div></div><!--Menu-->



<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.vakata</td></tr></table></blockquote><b>object</b> Holds all helper objects.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>$.vakata.array_remove = function(</td><td class=PParameter nowrap>array,</td></tr><tr><td></td><td class=PParameter nowrap>from,</td></tr><tr><td></td><td class=PParameter nowrap>to</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Makes it possible to remove an item (or a group of items) form an array. </div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.vakata.css</td></tr></table></blockquote><b>object</b> holds all CSS related functions</div></div><div class=CToolTip id="tt4"><div class=CFunction>Retrieves or deletes a specific rule.</div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.vakata.dnd</td></tr></table></blockquote><b>object</b> holds all DND related functions</div></div><div class=CToolTip id="tt6"><div class=CFunction>Use this function to start a drag (usually with the mousedown event)</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>$.vakata.xslt = function (</td><td class=PParameter nowrap>xml,</td></tr><tr><td></td><td class=PParameter nowrap>xsl,</td></tr><tr><td></td><td class=PParameter nowrap>callback</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>This functions transforms a XML string using a XSL string. </div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>$.vakata.context</td></tr></table></blockquote><b>object</b> holds all context menu related functions and variables.</div></div><div class=CToolTip id="tt9"><div class=CFunction>Removes a rule, this functions is a shortcut to $.vakata.css.get_css with the delete flag set to true.</div></div><div class=CToolTip id="tt10"><div class=CEvent>Marks the start of the drag. </div></div><div class=CToolTip id="tt11"><div class=CEvent>Triggered multiple times while dragging. </div></div><div class=CToolTip id="tt12"><div class=CVariable><b>integer</b> amount of pixels required to move before the drag is started. </div></div><div class=CToolTip id="tt13"><div class=CEvent>Marks the end of the drag. </div></div><div class=CToolTip id="tt14"><div class=CEvent>Triggered when the context menu is parsed but not yet shown. </div></div><div class=CToolTip id="tt15"><div class=CFunction>Shows the context menu. </div></div><div class=CToolTip id="tt16"><div class=CVariable><b>object</b> Used to construct a context menu entry, this structure will always be a part of an object.</div></div><div class=CToolTip id="tt17"><div class=CEvent>Triggered when the context menu is shown. </div></div><div class=CToolTip id="tt18"><div class=CEvent>Triggered when the context menu is hidden. </div></div><!--END_ND_TOOLTIPS-->




<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>


<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>